home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3dm / audio / alCloseEventQueue.z / alCloseEventQueue
Encoding:
Text File  |  2002-10-03  |  3.1 KB  |  67 lines
  1.  
  2.  
  3.  
  4. aaaallllCCCClllloooosssseeeeEEEEvvvveeeennnnttttQQQQuuuueeeeuuuueeee((((3333ddddmmmm))))                                  aaaallllCCCClllloooosssseeeeEEEEvvvveeeennnnttttQQQQuuuueeeeuuuueeee((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      alCloseEventQueue - close an audio event queue
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////aaaauuuuddddiiiioooo....hhhh>>>>
  13.  
  14.      iiiinnnntttt aaaallllCCCClllloooosssseeeeEEEEvvvveeeennnnttttQQQQuuuueeeeuuuueeee((((AAAALLLLeeeevvvveeeennnnttttQQQQuuuueeeeuuuueeee qqqquuuueeeeuuuueeee))))
  15.  
  16. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRR
  17.      _q_u_e_u_e   expects the AAAALLLLeeeevvvveeeennnnttttQQQQuuuueeeeuuuueeee handle for the audio event queue you
  18.              want to close.  This handle is the returned value of the
  19.              aaaallllOOOOppppeeeennnnEEEEvvvveeeennnnttttQQQQuuuueeeeuuuueeee((((3333ddddmmmm)))) call.
  20.  
  21. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  22.      aaaallllCCCClllloooosssseeeeEEEEvvvveeeennnnttttQQQQuuuueeeeuuuueeee closes the given audio event _q_u_e_u_e and frees the
  23.      associated resources.  Any events remaining in the _q_u_e_u_e will be lost.
  24.      Since _q_u_e_u_e will be deallocated, it cannot be used in any subsequent
  25.      audio library function calls.
  26.  
  27. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  28.      Upon successful completion, aaaallllCCCClllloooosssseeeeEEEEvvvveeeennnnttttQQQQuuuueeeeuuuueeee((((3333ddddmmmm)))) returns 0. Otherwise
  29.      aaaallllCCCClllloooosssseeeeEEEEvvvveeeennnnttttQQQQuuuueeeeuuuueeee((((3333ddddmmmm)))) returns -1 and sets an error number which can be
  30.      retrieved using oooosssseeeerrrrrrrroooorrrr((((3333CCCC)))).
  31.  
  32.      aaaallllCCCClllloooosssseeeeEEEEvvvveeeennnnttttQQQQuuuueeeeuuuueeee((((3333ddddmmmm)))) can fail for the following reason:
  33.  
  34.      AAAALLLL____BBBBAAAADDDD____IIIINNNNVVVVAAAALLLLIIIIDDDD____EEEEVVVVEEEENNNNTTTT____QQQQUUUUEEEEUUUUEEEE
  35.                    _A_L_e_v_e_n_t_Q_u_e_u_e is either invalid or null.
  36.  
  37. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  38.      alOpenEventQueue(3dm), oserror(3C)
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.